/*
    Licensed to the Apache Software Foundation (ASF) under one
    or more contributor license agreements.  See the NOTICE file
    distributed with this work for additional information
    regarding copyright ownership.  The ASF licenses this file
    to you under the Apache License, Version 2.0 (the
    "License"); you may not use this file except in compliance
    with the License.  You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing,
    software distributed under the License is distributed on an
    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
    KIND, either express or implied.  See the License for the
    specific language governing permissions and limitations
    under the License.
 */
package erwiki.plugins;

import java.io.IOException;
import java.util.Map;
import java.util.ResourceBundle;

import org.apache.log4j.Logger;
import org.elwiki_data.WikiPage;
import org.osgi.framework.FrameworkUtil;

import erwiki.api.WikiPartReference;
import erwiki.api.core.Engine;
import erwiki.api.core.WikiContext;
import erwiki.api.exceptions.InternalWikiException;
import erwiki.api.exceptions.PluginException;
import erwiki.api.filters.FilterManager;
import erwiki.api.pages.PageManager;
import erwiki.api.parser.Heading;
import erwiki.api.parser.HeadingListener;
import erwiki.api.parser.MarkupParser;
import erwiki.api.plugin.PluginManager;
import erwiki.api.plugin.WikiPlugin;
import erwiki.api.preferences.Preferences;
import erwiki.api.render.RenderingManager;
import erwiki.api.rwc.RWC;
import erwiki.api.variables.VariableManager;
import erwiki.util.TextUtil;

/**
 * Плагин ErWiki. Предоставляет оглавление страницы.
 * <p>
 * Параметры плагина:
 * <ul>
 * <li><b>title</b> - Название оглавления.</li>
 * <li><b>numbered</b> - если <em>true</em>, то автоматически генерируются номера для
 * заголовков.</li>
 * <li><b>start</b> - При использовании нумерованного списка задает начальный номер.</li>
 * <li><b>prefix</b> - При использовании нумерованного списка задает префикс, используемый для
 * списка.</li>
 * </ul>
 */
public class TableOfContentsPlugin implements WikiPlugin, HeadingListener {

	private static final Logger log = Logger.getLogger(TableOfContentsPlugin.class);

	/** Имя параметра для настройки <i>title</i>. Значение <tt>{@value}</tt>. */
	public static final String PARAM_TITLE = "title";

	/** Имя параметра для настройки <i>numbered</i>. Значение <tt>{@value}</tt>. */
	public static final String PARAM_NUMBERED = "numbered";

	/** Имя параметра для настройки <i>start</i>. Значение <tt>{@value}</tt>. */
	public static final String PARAM_START = "start";

	/** Имя параметра для настройки <i>prefix</i>. Значение <tt>{@value}</tt>. */
	public static final String PARAM_PREFIX = "prefix";

	/**
	 * Этот атрибут спрятан в WikiContext, чтобы гарантировать отсутствие зацикливания.
	 */
	private static final String VAR_ALREADY_PROCESSING = "__TableOfContents.processing";

	StringBuffer m_buf = new StringBuffer();
	private boolean m_usingNumberedList = false;
	private String m_prefix = "";
	private int m_starting = 0;
	private int m_level1Index = 0;
	private int m_level2Index = 0;
	private int m_level3Index = 0;
	private int m_lastLevel = 0;

	@WikiPartReference
	PageManager pageManager;

	@WikiPartReference
	FilterManager filterManager;

	@WikiPartReference
	RenderingManager renderingManager;

	@WikiPartReference
	VariableManager variableManager;

	/** {@inheritDoc} */
	@Override
	public void headingAdded(Heading hd) {
		// log.debug("HD: " + hd.m_level + ", " + hd.m_titleText + ", " + hd.m_titleAnchor);

		switch (hd.m_level) {
		case Heading.HEADING_SMALL:
			m_buf.append("<li class=\"toclevel-3\">");
			m_level3Index++;
			break;
		case Heading.HEADING_MEDIUM:
			m_buf.append("<li class=\"toclevel-2\">");
			m_level2Index++;
			break;
		case Heading.HEADING_LARGE:
			m_buf.append("<li class=\"toclevel-1\">");
			m_level1Index++;
			break;
		default:
			throw new InternalWikiException("Unknown depth in toc! (Please submit a bug report.)");
		}

		if (m_level1Index < m_starting) {
			// на случай, если у нас никогда не было большого заголовка...
			m_level1Index++;
		}
		if ((m_lastLevel == Heading.HEADING_SMALL) && (hd.m_level != Heading.HEADING_SMALL)) {
			m_level3Index = 0;
		}
		if (((m_lastLevel == Heading.HEADING_SMALL) || (m_lastLevel == Heading.HEADING_MEDIUM))
				&& (hd.m_level == Heading.HEADING_LARGE)) {
			m_level3Index = 0;
			m_level2Index = 0;
		}

		String titleSection = hd.m_titleSection.replace('%', '_');
		String pageName = null;
		try {
			Engine engine = RWC.INSTANCE.getEngine();
			pageName = engine.encodeName(RWC.INSTANCE.getPage().getName()).replace('%', '_');
		} catch (IOException e) {
			// TODO: Auto-generated catch block
			e.printStackTrace();
		}

		String sectref = "#section-" + pageName + "-" + titleSection;

		m_buf.append("<a class=\"wikipage\" href=\"" + sectref + "\">");
		if (m_usingNumberedList) {
			switch (hd.m_level) {
			case Heading.HEADING_SMALL:
				m_buf.append(m_prefix + m_level1Index + "." + m_level2Index + "." + m_level3Index + " ");
				break;
			case Heading.HEADING_MEDIUM:
				m_buf.append(m_prefix + m_level1Index + "." + m_level2Index + " ");
				break;
			case Heading.HEADING_LARGE:
				m_buf.append(m_prefix + m_level1Index + " ");
				break;
			default:
				throw new InternalWikiException("Unknown depth in toc! (Please submit a bug report.)");
			}
		}
		m_buf.append(TextUtil.replaceEntities(hd.m_titleText) + "</a></li>\n");

		m_lastLevel = hd.m_level;
	}

	/** {@inheritDoc} */
	@Override
	public String execute(WikiContext context, Map<String, String> params) throws PluginException {
		WikiPage page = context.getPage();
		PluginManager pluginManager = context.getEngine().getManager(PluginManager.class);
		ResourceBundle rb = pluginManager.getBundle( //
				Preferences.getLocale(), FrameworkUtil.getBundle(this.getClass()));

		if (context.getVariable(VAR_ALREADY_PROCESSING) != null) {
			return "<a href=\"#section-TOC\" class=\"toc\">" + rb.getString("tableofcontents.title") + "</a>";
		}

		/* Инициализация переменных. */
		m_buf.setLength(0);
		m_usingNumberedList = false;
		m_prefix = "";
		m_starting = 0;
		m_level1Index = 0;
		m_level2Index = 0;
		m_level3Index = 0;
		m_lastLevel = 0;
		StringBuilder sb = new StringBuilder();

		sb.append("<div class=\"toc\">\n");
		sb.append("<div class=\"collapsebox\">\n");

		sb.append("<h4 id=\"section-TOC\">");
		String title = params.get(PARAM_TITLE);
		sb.append((title != null) ? TextUtil.replaceEntities(title) : rb.getString("tableofcontents.title"));
		sb.append("</h4>\n");

		// должен ли использоваться упорядоченный список?
		if (params.containsKey(PARAM_NUMBERED)) {
			String numbered = params.get(PARAM_NUMBERED);
			m_usingNumberedList = switch (numbered.toLowerCase()) {
			case "true", "yes" -> true;
			default -> false;
			};
		}

		// если используется нумерованный список, то взять остальные параметры (если они есть)...
		if (m_usingNumberedList) {
			int start = 0;
			String startStr = params.get(PARAM_START);
			if ((startStr != null) && (startStr.matches("^\\d+$"))) {
				start = Integer.parseInt(startStr);
			}
			if (start < 0) {
				start = 0;
			}

			m_starting = start;
			m_level1Index = start - 1;
			if (m_level1Index < 0) {
				m_level1Index = 0;
			}
			m_level2Index = 0;
			m_level3Index = 0;
			m_prefix = TextUtil.replaceEntities(params.get(PARAM_PREFIX));
			if (m_prefix == null) {
				m_prefix = "";
			}
			m_lastLevel = Heading.HEADING_LARGE;
		}

		try {
			String wikiText = page.getContentText(context.getPageVersion());
			boolean runFilters = "true".equals(variableManager.getValue(VariableManager.VAR_RUNFILTERS, "true"));

			if (runFilters) {
				try {
					wikiText = filterManager.doPreTranslateFiltering(wikiText);

				} catch (Exception e) {
					log.error("Could not construct table of contents: Filter Error", e);
					throw new PluginException("Unable to construct table of contents (see logs)");
				}
			}

			context.setVariable(VAR_ALREADY_PROCESSING, "x");

			MarkupParser parser = renderingManager.getParser(wikiText);
			parser.addHeadingListener(this);
			parser.parse();

			sb.append("<ul>\n").append(m_buf.toString()).append("</ul>\n");
		} catch (IOException e) {
			log.error("Could not construct table of contents", e);
			throw new PluginException("Unable to construct table of contents (see logs)");
		}

		sb.append("</div>\n</div>\n");

		return sb.toString();
	}

}
